add packages and links to algorithms doc#3
add packages and links to algorithms doc#3AmberLee2427 wants to merge 11 commits intoMovingUniverseLab:mainfrom
Conversation
Added microlux support and updated algorithm table.
Added GitHub and documentation links for BAGLE, VBM, MulensModel, microlux, and microJAX.
Corrected formatting of model definitions for clarity.
Updated the algorithm usage table and added missing entries.
There was a problem hiding this comment.
Pull request overview
Updates the repository’s microlensing code comparison docs by expanding the model-fitting algorithms table and adding (or intending to add) package links for easier navigation across supported tools.
Changes:
- Expanded the model-fitting algorithms overview table to include additional packages/approaches.
- Added GitHub/Documentation links under “Package Specific Notes” (with some sections currently commented out).
- Added a docs link for VBMicrolensing in the master “List of codes”.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| Model_Fitting_Algorithms.md | Expands the fitting-algorithms comparison table and adds per-package GitHub/Docs links/sections. |
| Model_Class_Support.md | Reformats the “Definitions” block for cleaner Markdown rendering. |
| List_of_codes.md | Adds the missing VBMicrolensing documentation link in the codes table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Algorithm | BAGLE | VBM | MM | pyLIMA | RTModel | eesunhong | microlux | microJax | | ||
| |--------------------------------------------------------|-------|-----|----|--------|---------|-----------|----------|----------| |
There was a problem hiding this comment.
The overview table uses microJax as the column name, but other docs in this repo use microjax (lowercase) and the GitHub repo is microjax. Please standardize the name/capitalization to avoid confusion and broken search matches.
| <!-- | ||
| ### `microlux` | ||
|
|
||
| **GitHub Link:** [https://github.com/CoastEgo/microlux](https://github.com/CoastEgo/microlux) | ||
| **Documentation Link:** [https://coastego.github.io/microlux/](https://coastego.github.io/microlux/) | ||
|
|
||
|
|
||
|
|
||
| ### `microJAX` | ||
|
|
||
| **GitHub Link:** [https://github.com/ShotaMiyazaki94/microjax](https://github.com/ShotaMiyazaki94/microjax) | ||
| **Documentation Link:** [https://shotamiyazaki94.github.io/microjax/](https://shotamiyazaki94.github.io/microjax/) | ||
| --> |
There was a problem hiding this comment.
The microlux / microJAX package notes are inside an HTML comment block, so the GitHub/Docs links won’t render. If the intent is to include these links on the page, remove the <!-- ... --> wrapper (or replace with a clear TODO note outside of an HTML comment).
| ### pyLIMA | ||
|
|
There was a problem hiding this comment.
Section headings use inconsistent formatting (e.g., ### BAGLE`` uses backticks, while ### pyLIMA does not). Please standardize heading formatting across packages so the document scans uniformly.
| <!-- | ||
| ### `VBM` | ||
|
|
||
| **GitHub Link:** [https://github.com/valboz/VBMicrolensing](https://github.com/valboz/VBMicrolensing) | ||
| **Documentation Link:** [https://github.com/valboz/VBMicrolensing/tree/main/docs](https://github.com/valboz/VBMicrolensing/tree/main/docs) | ||
|
|
||
|
|
||
| <!-- ### MulensModel --> | ||
|
|
||
| ### `MulensModel` | ||
|
|
||
| **GitHub Link:** [https://github.com/rpoleski/MulensModel](https://github.com/rpoleski/MulensModel) | ||
| **Documentation Link:** [https://rpoleski.github.io/MulensModel/](https://rpoleski.github.io/MulensModel/) | ||
| --> |
There was a problem hiding this comment.
The VBM and MulensModel sections are wrapped in an HTML comment block, so their headings and links will not render in the published Markdown. If these sections are meant to be visible, remove the surrounding <!-- ... --> or narrow the comment to only the content you intend to hide.
|
|
||
|
|
||
|
|
||
| ### essunhong |
There was a problem hiding this comment.
Package name heading is spelled essunhong, but elsewhere in this repo (table header and links) it’s eesunhong. This inconsistency makes it harder to search/scan the doc; please standardize the spelling.
| ### essunhong | |
| ### eesunhong |
No description provided.